package com.zzyl.base;

import com.fasterxml.jackson.annotation.JsonIgnore;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;
import java.time.LocalDateTime;
import java.util.HashMap;
import java.util.Map;

/**
 * BaseEntity 是一个实体基础类，定义了在许多实体类中可能会重复出现的通用字段和方法，
 * 这种设计遵循了面向对象编程中的 继承（Inheritance） 原则，
 * 通过抽象出公共的属性和方法，减少代码重复，提高代码的复用性和可维护性。
 *
 * 设计模式关联: 这是面向对象编程的基本原则，也是**模板方法模式（Template Method Pattern）**的一种体现。
 * BaseEntity 可以看作是定义了一个模板，子类可以根据需要扩展或覆盖模板中的某些部分。
 */
@Data
@NoArgsConstructor
@ApiModel(description = "实体基础类")
public class BaseEntity implements Serializable {
    /**
     * 主键
     */
    @ApiModelProperty(value = "主键")
    public Long id;

    /**
     * 创建时间
     */
    @ApiModelProperty(value = "创建时间")
    public LocalDateTime createTime;

    /**
     * 更新时间
     */
    @ApiModelProperty(value = "更新时间")
    public LocalDateTime updateTime;

    /**
     * 创建人
     */
    @ApiModelProperty(value = "创建人id")
    private Long createBy;

    /**
     * 更新人
     */
    @ApiModelProperty(value = "更新人id")
    private Long updateBy;

    /**
     * 备注
     */
    @ApiModelProperty(value = "备注")
    private String remark;

    /**
     * 创建人
     */
    @ApiModelProperty(value = "创建人名称")
    private String creator;

    /**
     * 更新人
     */
    @ApiModelProperty(value = "更新人名称")
    private String updater;

    public BaseEntity(Long id) {
        this.id = id;
    }

    /**
     *  params：一个 Map 类型，用于存储动态扩展参数，满足一些灵活的需求。
     * JsonIgnore注解，避免其出现在 JSON 序列化或 Swagger 文档中，防止干扰业务需求。
     * BaseEntity 中的 params 字段（Map<String, Object>）提供了一种动态扩展机制。
     * 如果某个实体类需要一些额外的、不常用的属性，可以将它们存储在 params 中，而无需修改 BaseEntity 或实体类的定义。
     * 这种设计有点类似于**装饰器模式（Decorator Pattern）**的思想，允许动态地向对象添加额外的属性或行为。
     */
    @JsonIgnore
    private Map<String, Object> params;

    /**
     * 获取动态扩展参数（懒加载）。
     * 当参数未初始化时，自动创建一个空的 HashMap 实例。
     * 这是一种延迟初始化的策略，可以避免不必要的对象创建，提高性能。
     * @return 动态参数 Map
     */
    public Map<String, Object> getParams() {
        if (params == null) {
            params = new HashMap<>();
        }
        return params;
    }
}
